3.8 Step 7: Settle Transaction

Merchants who submit their request with a TransactionType "02" , will have to perform an additional step to finalise the settlement of the transaction. A pre–authorised transaction can be settled in one of the two following ways:

If this Settle step is not called for some reason (e.g. purchase cannot be fulfilled),
then the transaction should be cancelled in order to release those funds from the customer's credit card (see 3.13 Cancel Pre-Auth API).


3.8.1 Manual Settlements

To perform a manual settlement do the following:

Figure 13. Manual Transaction Settle

3.8.2 API Settlements

A transaction can also be settled by making a call to the Vodacom Payment Gateway as follows: The API payload can be sent as JSON.

3.8.2.1 Request

Table 13. API Fields for Settle Requests
Field Name
(Case–Sensitive)
Type
(max length)
Required
Mandatory
Optional
Description
Username ^ String M Merchant Technical users VPG account username.
Password ^ String M Merchant Technical users VPG account password.
Destination ^ String M Name of function being invoked (in this case should be set to SETTLE)
TransactionID String M Unique value to identify a transaction. Returned by Vodacom Payment Gateway on the postback message
https://psp.vodacompaymentgateway.co.za/api/pay/transaction/settle/{transactionId}
Figure 14. API Settle Request – JSON
Figure 15. API Settle Request – XML

3.8.2.2 Response

Table 14. API Fields for Settle Response
Field Name
(Case–Sensitive)
Description
Code See 4.4 Appendix D: Bank Response Codes
Message Description of response
TransactionID Unique value to identify a transaction. Returned by Vodacom Payment Gateway on the postback message
Figure 16. Settle Response Message – JSON
Figure 17. Settle Response Message – XML

3.8.2.3 API Endpoints

Table 15. Settlements API Service Endpoints
URL Type URL Value
API: Test/QA ^ https://qa.vodacompaymentgateway.co.za/Payserver/Service/Execute
API: Live/PROD ^ https://psp.vodacompaymentgateway.co.za/Payserver/Service/Execute
Figure 18. Settlements API Sample Call – JSON
Figure 19. Settlements API Sample Call – XML

Continue

Return